/* 
 *  Copyright (c) 2009-2011, Michael Bedward. All rights reserved. 
 *   
 *  Redistribution and use in source and binary forms, with or without modification, 
 *  are permitted provided that the following conditions are met: 
 *   
 *  - Redistributions of source code must retain the above copyright notice, this  
 *    list of conditions and the following disclaimer. 
 *   
 *  - Redistributions in binary form must reproduce the above copyright notice, this 
 *    list of conditions and the following disclaimer in the documentation and/or 
 *    other materials provided with the distribution.   
 *   
 *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND 
 *  ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 
 *  WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 
 *  DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR 
 *  ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES 
 *  (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 
 *  LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON 
 *  ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 
 *  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS 
 *  SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
 */   

package org.jaitools.jiffle;

import java.util.List;

/**
 * Exception class for errors encountered while compiling a script or
 * working with runtime objects.
 * 
 * @author Michael Bedward
 * @since 0.1
 * @version $Id$
 */
public class JiffleException extends Exception {

    /**
     * Create a new instance from an incoming exception.
     * 
     * @param thrwbl incoming exception
     */
    public JiffleException(Throwable thrwbl) {
        super(thrwbl);
    }

    /**
     * Creates a new instance with the given message.
     * 
     * @param msg error message
     */
    public JiffleException(String msg) {
        super(msg);
    }

    /**
     * Creates a new instance with the given list of messages.
     * 
     * @param errors list of error messages
     */
    public JiffleException(List<String> errors) {
        super(listToString(errors));
    }

    /**
     * Creates a new instance from the given message and base object.
     * This is used by Jiffle to wrap Janino exceptions.
     * 
     * @param string error message
     * @param thrwbl base {@code Throwable} object
     */
    public JiffleException(String string, Throwable thrwbl) {
        super(string, thrwbl);
    }
    
    
    /**
     * Concatenates a list of messages, separating them with newline
     * characters.
     * 
     * @param msgList list of messages
     * 
     * @return the concatenated messages
     */
    private static String listToString(List<String> msgList) {
        StringBuilder sb = new StringBuilder();
        for (String msg : msgList) {
            sb.append(msg).append("\n");
        }
        return sb.toString();
    }

}
